/*
 * Copyright 2012-2021 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.boot.context.properties;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import org.springframework.core.annotation.AliasFor;
import org.springframework.stereotype.Indexed;

/**
 * 外部化配置的注解。添加到类定义或 {@code @Configuration} 类中的 {@code @Bean} 方法，
 * 如果你想绑定和校验一些外部属性（例如来自 .properties 文件）。
 * <p>
 * 绑定操作通过调用被注解类的 setter 方法完成，或者如果使用了 {@link ConstructorBinding @ConstructorBinding}，
 * 则通过绑定构造函数参数完成。
 * <p>
 * 注意，与 {@code @Value} 不同，SpEL 表达式不会被求值，因为属性值是外部化的。
 *
 * @author Dave Syer
 * @since 1.0.0
 * @see ConfigurationPropertiesScan
 * @see ConstructorBinding
 * @see ConfigurationPropertiesBindingPostProcessor
 * @see EnableConfigurationProperties
 */
@Target({ ElementType.TYPE, ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Indexed
public @interface ConfigurationProperties {

	/**
	 * 允许绑定到此对象的属性前缀。同 {@link #prefix()} 同义。
	 * 有效的前缀由一个或多个用点分隔的单词组成（例如 {@code "acme.system.feature"}）。
	 * @return 要绑定的属性前缀
	 */
	@AliasFor("prefix")
	String value() default "";

	/**
	 * 允许绑定到此对象的属性前缀。同 {@link #value()} 同义。
	 * 有效的前缀由一个或多个用点分隔的单词组成（例如 {@code "acme.system.feature"}）。
	 * @return 要绑定的属性前缀
	 */
	@AliasFor("value")
	String prefix() default "";

	/**
	 * 标记绑定到此对象时是否应忽略无效字段。
	 * “无效”指根据所用绑定器判断的无效，通常意味着字段类型错误（或无法转换成正确类型）。
	 * @return 标记值（默认 false）
	 */
	boolean ignoreInvalidFields() default false;

	/**
	 * 标记绑定到此对象时是否应忽略未知字段。
	 * “未知字段”可能是配置属性中的错误信号。
	 * @return 标记值（默认 true）
	 */
	boolean ignoreUnknownFields() default true;

}
